Appliance SupportBundle Info

Appliance SupportBundle Info
Appliance SupportBundle Info

This schema was added in vSphere API 7.0.1.0.

JSON Example
{
    "description": "string",
    "status": "string",
    "generation_time": "string",
    "url": "string",
    "expiration_time": "string",
    "downloadable": false,
    "size": 0,
    "failure_reason": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": "Vapi Std NestedLocalizableMessage Object",
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "checksum_value": "string",
    "id": "string",
    "content_type": "string"
}
string
description
Required

Support bundle creation description.

This property was added in vSphere API 7.0.1.0.

string
status
Required

Status of the task

For more information see: Appliance SupportBundle CreationStatus.

This property was added in vSphere API 7.0.1.0.

string As date-time As date-time
generation_time
Optional

Support bundle generation time.

This property was added in vSphere API 7.0.1.0.

This property is optional and it is only relevant when the value of status is Appliance SupportBundle CreationStatus.SUCCEEDED.

string As uri As uri
url
Optional

Support bundle downlooad URL.

This property was added in vSphere API 7.0.1.0.

This property is optional and it is only relevant when the value of status is Appliance SupportBundle CreationStatus.SUCCEEDED.

string As date-time As date-time
expiration_time
Optional

Download expiration time.

This property was added in vSphere API 7.0.1.0.

This property is optional and it is only relevant when the value of status is Appliance SupportBundle CreationStatus.SUCCEEDED.

boolean
downloadable
Optional

Support bundle availability for download.

This property was added in vSphere API 7.0.1.0.

This property is optional and it is only relevant when the value of status is Appliance SupportBundle CreationStatus.SUCCEEDED.

integer As int64 As int64
size
Optional

Support bundle file size in KBs.

This property was added in vSphere API 7.0.1.0.

This property is optional and it is only relevant when the value of status is Appliance SupportBundle CreationStatus.SUCCEEDED.

failure_reason
Optional

Reason for failure

This property was added in vSphere API 7.0.1.0.

This property is optional and it is only relevant when the value of status is Appliance SupportBundle CreationStatus.FAILED.

string
checksum_value
Optional

Support bundle SHA256 checksum value.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of status is Appliance SupportBundle CreationStatus.SUCCEEDED.

string
id
Optional

Identifier of the support bundle.

This property was added in vSphere API 8.0.2.0.

This property is optional because it was added in a newer version than its parent node.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.appliance.supportbundle. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.appliance.supportbundle.

string
content_type
Optional

Describes the content type (ContentType) collected in support bundle.

For more information see: Appliance SupportBundle ContentType.

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of status is Appliance SupportBundle CreationStatus.SUCCEEDED.